Corrected hotkey for code comments on Mac#3901
Corrected hotkey for code comments on Mac#3901Lk-ux wants to merge 1 commit intojavascript-tutorial:masterfrom
Conversation
javascript-translate-bot
added
the
review needed
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Mac hotkey documentation for code commenting in a JavaScript tutorial article, changing from a generic substitution instruction to specific key combinations.
Key Changes:
- Replaces generic Mac modifier key substitution guidance with explicit hotkey combinations
- Specifies
Cmd+/for single-line comments on Mac - Adds
Option+Shift+Aas the VS Code multiline comment hotkey for Mac
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```smart header="Use hotkeys!" | ||
| In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd` instead of `key:Ctrl` and `key:Option` instead of `key:Shift`. | ||
| In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Option+Shift+A` (on VS Code) for multiline comments. |
There was a problem hiding this comment.
The multiline comment hotkey documentation has inconsistencies:
-
Editor specificity: Adding "(on VS Code)" only for multiline comments is inconsistent since the earlier part of the sentence refers to "most editors" without specifying which one. This creates confusion about whether the Mac instructions apply generally or only to VS Code.
-
Key order: The standard convention is to list modifier keys in order (Shift before Option), so it should be
key:Shift+Option+Arather thankey:Option+Shift+A. -
Incomplete information: If you're going to specify VS Code for multiline comments, you should clarify what applies to other editors. Alternatively, provide the general Mac equivalent like the original approach, or note that multiline comment hotkeys vary by editor.
Consider revising to either:
- Keep it general: "For Mac, try
key:Cmd+/for single-line comments andkey:Cmd+Option+/orkey:Shift+Option+Afor multiline comments (varies by editor)." - Or be consistent about editor-specificity throughout the sentence.
| In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Option+Shift+A` (on VS Code) for multiline comments. | |
| In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Cmd+Option+/` or `key:Shift+Option+A` for multiline comments (hotkeys may vary by editor). |
|
@Lk-ux please check some of the comments |
4 participants
No description provided.